--- layout: default --- {{ content }} Meshery API.
API docs by Redocly

Meshery API. (0.4.27)

Download OpenAPI specification:Download

License: Apache-2.0

the purpose of this application is to provide an application that is using plain go code to define an API

This should demonstrate all the possible comment annotations that are available to turn go code into a fully compliant swagger 2.0 spec

ApplicationsAPI

Handle POST request for Application File Deploy

Deploy an attached application file with the request

Authorizations:
token
Request Body schema: multipart/form-data
Upload Yaml/Yml File
string <binary>

Responses

Response samples

Content type
application/json
{
  • "location": { },
  • "name": "string",
  • "type": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "application_file": "string",
  • "source_content": [
    ]
}

Handle DELETE request for Application File Deploy

Delete a deployed application file with the request

Authorizations:
token

Responses

Handle POST request for Application Files

Updates the design for the provided application

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "name": "string",
  • "type": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "application_file": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "source_content": [
    ],
  • "user_id": "string"
}

Handle Delete for a Meshery Application File

Deletes a meshery application file with ID: id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Handle GET request for Meshery Application with the given id

Fetches the list of all applications saved by the current user ?updated_after= timestamp should be of the format YYYY-MM-DD HH:MM:SS ?order={field} orders on the passed field ?search= A string matching is done on the specified application name ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 10

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "application_file": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "name": "string",
  • "source_content": [
    ],
  • "type": {
    },
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Handle GET request for Meshery Application with the provided type

Get application file type

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "user_id": "string",
  • "type": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "application_file": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "source_content": [
    ]
}

Handle GET request for Meshery Application with of source content

Get the application source-content

Authorizations:
token
Request Body schema: multipart/form-data
Upload Yaml/Yml File
string <binary>

Handle GET request for Application Files

Returns requests for all Meshery Applications

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total_count": 0
}

FilterAPI

Handle POST request for Filter File Deploy

Deploy an attached filter file with the request

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "visibility": "string",
  • "filter_file": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string",
  • "catalogData": { },
  • "created_at": "2019-08-24T14:15:22Z"
}

Handle DELETE request for Filter File Deploy

Delete a deployed filter file with the request

Authorizations:
token

Responses

FiltersAPI

Handle Clone for a Meshery Filter

Creates a local copy of a published filter with id: id

Authorizations:
token

Responses

Handle GET request for a Meshery Filter

Fetches the Meshery Filter with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "user_id": "string",
  • "visibility": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "filter_file": "string",
  • "location": { },
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "catalogData": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Handle Delete for a Meshery Filter

Deletes a meshery filter with ID: id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Handle GET request for catalog filters

Used to get catalog filters

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string",
  • "catalogData": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "visibility": "string",
  • "filter_file": "string",
  • "name": "string"
}

Handle GET request for filter file with given id

Returns the Meshery Filter file saved by the current user with the given id

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "visibility": "string",
  • "catalogData": { },
  • "location": { },
  • "name": "string",
  • "user_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "filter_file": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Handle Publish for a Meshery Filter

Publishes filter to Meshery Catalog by setting visibility to published and setting catalog data

Authorizations:
token

Responses

Handle POST requests for Meshery Filters

Used to save/update a Meshery Filter

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "visibility": "string",
  • "location": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "filter_file": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string",
  • "catalogData": { }
}

Handle GET request for all filters

Returns all the Meshery Filters saved by the current user

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "filters": [
    ],
  • "page": 0,
  • "page_size": 0,
  • "total_count": 0
}

GetAllMeshmodelComponents

Handle GET request for getting meshmodel components across all models and categories.

Components can be further filtered through query parameter ?version={version} ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { },
  • "name": "string",
  • "version": "string"
}

GetAllMeshmodelComponentsByName

idGetAllMeshmodelComponentsByName

Handle GET request for getting meshmodel components of a specific type by name across all models and categories Example: /api/meshmodels/components/Namespace Components can be further filtered through query parameter ?version={version} If version is unspecified then all models are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?trim={[true]} When trim is set to true, the underlying schemas are not returned for entities ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { },
  • "name": "string",
  • "version": "string"
}

GetAllMeshmodelRelationships

Handle GET request for getting meshmodel relationships of a specific model.

Example: /api/meshmodel/model/kubernetes/relationship Relationships can be further filtered through query parameter ?version={version} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { },
  • "name": "string",
  • "version": "string"
}

GetMeshmodelCategories

idGetMeshmodelCategories

Handle GET request for getting all meshmodel categories ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{ }

GetMeshmodelComponentByModel

Handle GET request for getting meshmodel components of a specific specific. The component type/model name should be lowercase like "kubernetes", "istio"

Example: /api/meshmodels/models/kubernetes/components Components can be further filtered through query parameter ?version={version} ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { }
}

GetMeshmodelComponentByModelByCategory

Handle GET request for getting meshmodel components of a specific model and category. The component type/model name should be lowercase like "kubernetes", "istio"

Example: /api/meshmodels/categories/Orchestration and Management/models/kubernetes/components Components can be further filtered through query parameter ?version={version} ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "metadata": { },
  • "name": "string",
  • "version": "string",
  • "category": {
    },
  • "displayName": "string"
}

GetMeshmodelComponentsByNameByModel

Handle GET request for getting meshmodel components of a specific model.

Example: /api/meshmodels/models/kubernetes/components/Namespace Components can be further filtered through query parameter ?version={version} If version is unspecified then all models are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { },
  • "name": "string",
  • "version": "string"
}

GetMeshmodelComponentsByNameByModelByCategory

Handle GET request for getting meshmodel components of a specific type by model and category.

Example: /api/meshmodels/categories/Orchestration and Management/models/kubernetes/components/Namespace Components can be further filtered through query parameter ?version={version} If version is unspecified then all models are returned ?apiVersion={apiVersion} If apiVersion is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "version": "string",
  • "category": {
    },
  • "displayName": "string",
  • "metadata": { }
}

GetMeshmodelModels

Handle GET request for getting all meshmodel models. The component type/model name should be lowercase like "kubernetes", "istio"

Returns a list of registered models across all categories ?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "metadata": { }
}

GetMeshmodelModelsByCategories

Handle GET request for getting all meshmodel models for a given category. The component type/model name should be lowercase like "kubernetes", "istio"

?version={version} If version is unspecified then all models are returned ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "metadata": { },
  • "name": "string"
}

GetMeshmodelRelationshipByName

Handle GET request for getting meshmodel relationships of a specific model by name.

Example: /api/meshmodel/model/kubernetes/relationship/Edge Relationships can be further filtered through query parameter ?version={version} ?order={field} orders on the passed field ?sort={[asc/desc]} Default behavior is asc ?search={[true/false]} If search is true then a greedy search is performed ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 25. To return all results: pagesize=all

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "metadata": { },
  • "name": "string",
  • "version": "string",
  • "category": {
    }
}

GrafanaAPI

Handle GET request for Grafana configuration

Used for fetching Grafana configuration

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "grafanaAPIKey": "string",
  • "grafanaURL": "string",
  • "selectedBoardsConfigs": [
    ]
}

Handle POST request for Grafana configuration

Used for persisting Grafana configuration

Authorizations:
token
Request Body schema:
grafanaAPIKey
string
grafanaURL
string

Responses

Request samples

Content type
{
  • "grafanaAPIKey": "string",
  • "grafanaURL": "string"
}

Handle DELETE request for Grafana configuration

Used for Delete Grafana configuration

Authorizations:
token

Responses

Handle GET request for Grafana

Fetches and returns Grafana

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Handle GET request for Grafana boards

Used for fetching Grafana boards and panels

Authorizations:
token
query Parameters
dashboardSearch
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Handle POST request for Grafana boards

Used for persist Grafana boards and panel selections

Authorizations:
token

Responses

Handle GET request for Grafana ping

Used to initiate a Grafana ping

Authorizations:
token

Responses

Handle GET request for Grafana queries

Used for handling Grafana queries

Authorizations:
token

Responses

MeshmodelComponentGenerate

Handle POST request for component generation

Generates Meshery Components for the given payload

Authorizations:
token

Responses

MeshmodelValidate

Handle POST request for registering meshmodel components.

Validate the given value with the given schema

Authorizations:
token

Responses

Handle POST request for validate

Validate the given value with the given schema

Authorizations:
token

Responses

PatternsAPI

Handle GET request for catalog patterns

Used to get catalog patterns

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "catalogData": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "location": { },
  • "name": "string",
  • "pattern_file": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "visibility": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "user_id": "string"
}

Handle Delete for multiple Meshery Patterns

DeleteMultiMesheryPatternsHandler deletes patterns with the given ids

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Handles GET requests for component details for OAM objects

Returns details of a workload/trait/scope by given name and id in the URL

{type} being of either trait, scope, workload; registration of adapter capabilities. Example: /api/oam/workload/Application/asdqe123sa275sasd => Here {type} is "workload" {name} is "Application" and {id} is "asdqe123sa275sasd". It should be noted that all of three, i.e {type}, {name} and {id} must be valid

Authorizations:
token

Responses

Handle Publish for a Meshery Pattern

Publishes pattern to Meshery Catalog by setting visibility to published and setting catalog data

Authorizations:
token

Responses

Handle Clone for a Meshery Pattern

Creates a local copy of a published pattern with id: id

Authorizations:
token

Responses

Handle POST requests for patterns

Edit/update a meshery pattern

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "visibility": "string",
  • "catalogData": { },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "location": { },
  • "pattern_file": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string"
}

Handle GET request for patterns

Returns the list of all the patterns saved by the current user This will return all the patterns with their details ?updated_after= timestamp should be of the format YYYY-MM-DD HH:MM:SS ?order={field} orders on the passed field ?search= A string matching is done on the specified design name ?page={page-number} Default page number is 1 ?pagesize={pagesize} Default pagesize is 10

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "patterns": [
    ],
  • "total_count": 0
}

Handle POST request for Pattern Deploy

Deploy an attached pattern with the request

Authorizations:
token
Request Body schema: multipart/form-data
Upload Yaml/Yml File
string <binary>

Responses

Handle DELETE request for Pattern Deploy

Delete a deployed pattern with the request

Authorizations:
token

Responses

Handles GET requests for component details for OAM objects

Returns component details of a workload/trait/scope by given name in the URL

{type} being of either trait, scope, workload; registration of adapter capabilities. Example: /api/oam/workload/Application => Here {type} is "workload" and {name} is "Application" it should be noted that both {type} and {name} should be valid

Authorizations:
token

Responses

Handles the get requests for the OAM objects

Getting list of workloads/traits/scopes

{type} being of either trait, scope, workload; registration of adapter capabilities. Example: /api/oam/workload => Here {type} is "workload"

Authorizations:
token

Responses

Handles registering OMA objects

Adding a workload/trait/scope

{type} being of either trait, scope, workload; registration of adapter capabilities. Example: /api/oam/trait => Here {type} is "trait"

Authorizations:
token

Responses

Handle GET for a Meshery Pattern

Fetches the pattern with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "catalogData": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "location": { },
  • "user_id": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "pattern_file": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "visibility": "string"
}

Handle Delete for multiple Meshery Patterns

DeleteMultiMesheryPatternsHandler deletes patterns with the given ids

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

PerfAPI

Handle GET request to run a test

Runs the load test with the given parameters

Authorizations:
token
query Parameters
Query
object

PerformanceTestParameters contains parameters to run a performance test

Request Body schema:
Array of objects

Single or distributed load generators

duration
string

Length of time the endpoint will be under load

id
string
object
name
string
smp_version
string

Spec version

Responses

Request samples

Content type
{
  • "clients": [
    ],
  • "duration": "string",
  • "id": "string",
  • "labels": {
    },
  • "name": "string",
  • "smp_version": "string"
}

Handles GET requests for perf result

Returns an individual result from provider

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "MeshConfigID": "string",
  • "StartTime": "2019-08-24T14:15:22Z",
  • "TestID": "string",
  • "ActualQPS": 0,
  • "DetailsURI": "string",
  • "EndTime": "2019-08-24T14:15:22Z",
  • "EnvID": "string",
  • "Latencies": {
    },
  • "SMPVersion": "string"
}

Handles GET requests for perf results

Returns pages of all the perf results from Remote Provider

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0
}

PerformanceAPI

Handle GET requests for performance results of a profile

Returns single performance profile with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "concurrent_request": 0,
  • "content_type": "string",
  • "created_at": "string",
  • "request_cookies": "string",
  • "total_results": 0,
  • "duration": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updated_at": "string",
  • "load_generators": [
    ],
  • "name": "string",
  • "request_headers": "string",
  • "schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
  • "service_mesh": "string",
  • "endpoints": [
    ],
  • "last_run": "string",
  • "qps": 0,
  • "request_body": "string"
}

Handle Delete requests for performance profiles

Deletes a performance profile with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Handles GET requests for performance results

Returns pages of all the performance results from Remote Provider

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0
}

Handle GET requests for performance profiles

Returns the list of all the performance profiles saved by the current user

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "profiles": [
    ],
  • "total_count": 0
}

Handle POST requests for saving performance profile

Save performance profile using the current provider's persistence mechanism

Authorizations:
token
Request Body schema:
name
string

name of performance profile

qps
integer <int64>

qps in integer

service_mesh
string

service mesh for performance tests

concurrent_request
integer <int64>

number of concurrent requests

duration
string

duration of tests e.g. 30s

endpoints
Array of strings

array of urls of performance results

load_generators
Array of strings

array of load generators

Responses

Request samples

Content type
{
  • "name": "string",
  • "qps": 0,
  • "service_mesh": "string",
  • "concurrent_request": 0,
  • "duration": "string",
  • "endpoints": [
    ],
  • "load_generators": [
    ]
}

Response samples

Content type
application/json
{
  • "updated_at": "string",
  • "created_at": "string",
  • "endpoints": [
    ],
  • "name": "string",
  • "qps": 0,
  • "request_body": "string",
  • "request_cookies": "string",
  • "request_headers": "string",
  • "content_type": "string",
  • "duration": "string",
  • "load_generators": [
    ],
  • "total_results": 0,
  • "concurrent_request": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "last_run": "string",
  • "schedule": "0caaa334-df8e-492a-85be-f8a502a13416",
  • "service_mesh": "string"
}

Handle GET request for results of a profile

Fetchs pages of results from Remote Provider for the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0
}

Handle GET request to run a performance test

Runs the load test with the given parameters

Authorizations:
token
query Parameters
Body
object

PerformanceTestParameters contains parameters to run a performance test

Responses

PrometheusAPI

Handle GET request for Prometheus Ping

Used to ping prometheus

Authorizations:
token

Responses

Handle GET request for Prometheus Query

Used to prometheus queries

Authorizations:
token

Responses

Handle POST request for Prometheus board

Used to persist selected board and panels

Authorizations:
token
Request Body schema:
Array
Array of objects (Panel represents panels of different types defined in Grafana.)
templateVars
Array of strings
object

GrafanaBoard represents a Grafana board

Responses

Request samples

Content type
[
  • {
    }
]

Handle GET request for Prometheus static board

Used to fetch the static board

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Handle POST request for Prometheus board import

Used for importing Grafana board for Prometheus

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "panels": [
    ],
  • "slug": "string",
  • "template_vars": [
    ],
  • "title": "string",
  • "uid": "string",
  • "uri": "string",
  • "org_id": 0
}

Handle GET for Prometheus configuration

Used for fetching Prometheus configuration

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "prometheusURL": "string",
  • "selectedPrometheusBoardsConfigs": [
    ]
}

Handle POST for Prometheus configuration

Used for persisting Prometheus configuration

Authorizations:
token
Request Body schema:
string

Responses

Request samples

Content type
"string"

Handle DELETE for Prometheus configuration

Used for deleting Prometheus configuration

Authorizations:
token

Responses

ProvidersAPI

Handle GET request for React Components

handles the requests to serve react components from the provider package

Authorizations:
token

Responses

Handle GET request to provider UI

Servers providers UI

Authorizations:
token

Responses

Handle GET requests for Provider

Returns the capabilities.json for the provider

Authorizations:
token

Responses

Handle GET request for list of providers

Returns the available list of providers

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Handle GET request for the choice of provider

Update the choice of provider in system

Authorizations:
token
query Parameters
provider
string

Responses

SchedulesAPI

Handle GET reqeuest for Schedules

Returns the list of all the schedules saved by the current user

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "schedules": [
    ],
  • "total_count": 0
}

Handle POST reqeuest for Schedules

Save schedule using the current provider's persistence mechanism

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "cron_expression": "string"
}

Handle GET reqeuest for Schedules

Fetches and returns the schedule with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "cron_expression": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Handle DELETE reqeuest for Schedules

Deletes a schedule with the given id

Authorizations:
token
path Parameters
id
required
string <uuid>

id for a specific

Responses

Response samples

Content type
application/json
{
  • "page_size": 0,
  • "schedules": [
    ],
  • "total_count": 0,
  • "page": 0
}

ShareContent

Handle POST request for Sharing content

Used to share designs with others

Authorizations:
token

Responses

SystemAPI

Handle GET request for adapters

Fetches and returns all the adapters and ping adapters

Authorizations:
token
query Parameters
adapter
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Handle GET request for config sync

Used to send session data to the UI for initial sync

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "anonymousUsageStats": true,
  • "grafana": {
    },
  • "loadTestPrefs": {
    },
  • "meshAdapters": [
    ],
  • "prometheus": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usersExtensionPreferences": { },
  • "anonymousPerfResults": true
}

Handle POST requests for Kubernetes Context list

Returns the context list for a given k8s config

Authorizations:
token

Responses

Handle GET request for Kubernetes ping

Fetches server version to simulate ping

Authorizations:
token

Responses

Handle GET request for system/server version

Returns the running Meshery version

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "build": "string",
  • "commitsha": "string",
  • "latest": "string",
  • "outdated": true,
  • "release_channel": "string"
}

Handle POST request for Kubernetes Config

Used to add kubernetes config to System

Authorizations:
token

Responses

Handle DELETE request for Kubernetes Config

Used to delete kubernetes config to System

Authorizations:
token

Responses

Handle GET request for mesh-sync grafana

Fetches Prometheus and Grafana

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Handle DELETE requests to delete adapter config

Used to delete adapter configuration

Authorizations:
token
query Parameters
adapter
string

Responses

Handle POST requests to persist adapter config

Used to persist adapter config

Authorizations:
token
Request Body schema:
string

Responses

Request samples

Content type
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Handle GET request for fetching prometheus

Fetches Prometheus

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Handle POST requests for Adapter Operations

Used to send operations to the adapters

Authorizations:
token
query Parameters
adapter
string
query
string
customBody
string
namespace
string
deleteOp
string

Responses

UserAPI

Handlers GET request for User login

Redirects user for auth or issues session

Authorizations:
token

Responses

Handlers GET request for User logout

Redirects user for auth or issues session

Authorizations:
token

Responses

Handle GET for User info by ID

Returns User info

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "provider": "string",
  • "user_id": "string",
  • "avatar_url": "string",
  • "bio": "string",
  • "email": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string"
}

Handle GET for User Load Test Preferences

Returns User Load Test Preferences

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "loadTestPrefs": {
    },
  • "meshAdapters": [
    ],
  • "prometheus": {
    },
  • "updated_at": "2019-08-24T14:15:22Z",
  • "usersExtensionPreferences": { },
  • "anonymousPerfResults": true,
  • "anonymousUsageStats": true,
  • "grafana": {
    }
}

Handle GET for User Load Test Preferences

Updates User Load Test Preferences

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "usersExtensionPreferences": { },
  • "anonymousPerfResults": true,
  • "anonymousUsageStats": true,
  • "grafana": {
    },
  • "loadTestPrefs": {
    },
  • "meshAdapters": [
    ],
  • "prometheus": {
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}

Handle POST request for load test preferences

Used for persisting load test preferences

Authorizations:
token
Request Body schema:
Array of objects

Single or distributed load generators

duration
string

Length of time the endpoint will be under load

id
string
object
name
string
smp_version
string

Spec version

Responses

Request samples

Content type
{
  • "clients": [
    ],
  • "duration": "string",
  • "id": "string",
  • "labels": {
    },
  • "name": "string",
  • "smp_version": "string"
}

Handle DELETE request for load test preferences

Used for deleting load test preferences

Authorizations:
token
query Parameters
uuid
string <uuid>

Responses

Handle GET request for load test preferences

Used for fetching load test preferences

Authorizations:
token
query Parameters
uuid
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "smp_version": "string",
  • "clients": [
    ],
  • "duration": "string",
  • "id": "string",
  • "labels": {
    }
}

Handle GET request for tokens

Returns token from the actual provider in a file resposese: 200:

Authorizations:
token

Responses

Handle POST request for tokens

Receives token from the actual provider resposese: 200:

Authorizations:
token

Responses